Foxit PDF SDK
FoxitPDFSDKPython3.Md2PDFSettingData Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def Md2PDFSettingData ()
 Constructor. More...
 
def Set (page_width, page_height, margin_top, margin_bottom, margin_left, margin_right, base_font_size, custom_font_path, style_config_path, is_embed_font)
 Set value. More...
 

Static Public Attributes

 base_font_size = _fsdk.Md2PDFSettingData_base_font_size
 Base font size in points for body text. Default value: 10. More...
 
 custom_font_path = _fsdk.Md2PDFSettingData_custom_font_path
 Path to a TrueType font file for CJK or custom font support. More...
 
 is_embed_font = _fsdk.Md2PDFSettingData_is_embed_font
 Whether to embed font data in the output PDF. Default value: false.
 
 margin_bottom = _fsdk.Md2PDFSettingData_margin_bottom
 Bottom margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.
 
 margin_left = _fsdk.Md2PDFSettingData_margin_left
 Left margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of left and right margins must be less than page width.
 
 margin_right = _fsdk.Md2PDFSettingData_margin_right
 Right margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of left and right margins must be less than page width.
 
 margin_top = _fsdk.Md2PDFSettingData_margin_top
 Top margin in points. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.\ Default value: More...
 
 page_height = _fsdk.Md2PDFSettingData_page_height
 Page height in points. The value must be greater than 0. Default value: 792.
 
 page_width = _fsdk.Md2PDFSettingData_page_width
 Page width in points. The value must be greater than 0. Default value: 612.
 
 style_config_path = _fsdk.Md2PDFSettingData_style_config_path
 Path to a JSON style configuration file. More...
 

Detailed Description

This class represents setting data used for converting Markdown format files to PDF format files.

Constructor & Destructor Documentation

◆ Md2PDFSettingData()

def FoxitPDFSDKPython3.Md2PDFSettingData.Md2PDFSettingData ( )

Constructor.

Constructor, with parameters.

Parameters
[in]page_widthPage width in points. The value must be greater than 0. Default value: 612.
[in]page_heightPage height in points. The value must be greater than 0. Default value: 792.
[in]margin_topTop margin in points. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.\ Default value: 72.
[in]margin_bottomBottom margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.
[in]margin_leftLeft margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of left and right margins must be less than page width.
[in]margin_rightRight margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of left and right margins must be less than page width.
[in]base_font_sizeBase font size in points for body text. Default value: 10.
[in]custom_font_pathPath to a TrueType font file for CJK or custom font support.
[in]style_config_pathPath to a JSON style configuration file.
[in]is_embed_fontWhether to embed font data in the output PDF. Default value: false.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.Md2PDFSettingData.Set (   page_width,
  page_height,
  margin_top,
  margin_bottom,
  margin_left,
  margin_right,
  base_font_size,
  custom_font_path,
  style_config_path,
  is_embed_font 
)

Set value.

Parameters
[in]page_widthPage width in points. The value must be greater than 0. Default value: 612.
[in]page_heightPage height in points. The value must be greater than 0. Default value: 792.
[in]margin_topTop margin in points. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.\ Default value: 72.
[in]margin_bottomBottom margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.
[in]margin_leftLeft margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of left and right margins must be less than page width.
[in]margin_rightRight margin in points. Default value: 72. The value must be greater than or equal to 0. The sum of left and right margins must be less than page width.
[in]base_font_sizeBase font size in points for body text.
[in]custom_font_pathPath to a TrueType font file for CJK or custom font support.
[in]style_config_pathPath to a JSON style configuration file.
[in]is_embed_fontWhether to embed font data in the output PDF.
Returns
None.

Member Data Documentation

◆ base_font_size

FoxitPDFSDKPython3.Md2PDFSettingData.base_font_size = _fsdk.Md2PDFSettingData_base_font_size
static

Base font size in points for body text. Default value: 10.

Heading sizes are calculated as multiples of this value.

◆ custom_font_path

FoxitPDFSDKPython3.Md2PDFSettingData.custom_font_path = _fsdk.Md2PDFSettingData_custom_font_path
static

Path to a TrueType font file for CJK or custom font support.

When not empty, the specified font will be used for text rendering. Default value: empty string.

◆ margin_top

FoxitPDFSDKPython3.Md2PDFSettingData.margin_top = _fsdk.Md2PDFSettingData_margin_top
static

Top margin in points. The value must be greater than or equal to 0. The sum of top and bottom margins must be less than page height.\ Default value:

◆ style_config_path

FoxitPDFSDKPython3.Md2PDFSettingData.style_config_path = _fsdk.Md2PDFSettingData_style_config_path
static

Path to a JSON style configuration file.

When not empty, per-element font/size/color/bold/italic/line_spacing settings are loaded from the specified JSON file. Default value: empty string (built-in defaults apply).